System: Generate Smart Groups

Generate Smart Groups (SMARTGRPS via script) is a system-level command that triggers the service to auto-generate General or Station groups based on specified conditions. These conditions are defined by configuring Smart Group definitions and rules that govern the automatic creation of General or Station groups when the command is run.

You must have proper security authorization to execute this command. See FMS Security (and CMDSYS security event) for information about configuring security access for FMS commands.

See Configuring Smart Group Definitions and Running Generate Smart Groups Commands for more information about using this command via FMS Explorer.

See Scheduling FMS Command Tasks in the MSS for more information about scheduling commands.

See FMS ActiveX Controls and CxHmiFms for more information about using commands via FMS ActiveX controls on CygNet Studio or CygNet Vision screens.

See CxFms for more information about scripting commands.

Managing Generate Smart Groups Commands

Prior to running Generate Smart Groups commands, verify or configure the smart group definitions and component rules that define the automatic generation process. Generate Smart Groups command options are configured by users with proper security access, via the Extended Options button on the FMS Explorer Commands menu. See Configuring Smart Group Definitions for more information.

Command Definition Properties

The following command definition properties apply to Generate Smart Groups commands, when scheduling, creating, or editing commands via CygNet Explorer.

Property Description

FMS service

Select a Site.Service for the command from the available FMS service list in the drop-down menu.

Command

Select the desired Command name from the drop-down menu.

See FMS Commands for more information about available command types.

Priority

Select a processing queue Priority for the command from the drop-down menu.

Options from least to greatest priority are as follows.

  • Low level
  • Medium level
  • High level
  • User initiated transaction
  • Admin initiated transaction

Default value is Low level processing queue priority.

Logging

Select a Logging level for the command results from the drop-down menu.

Options are as follows.

  • Low — displays errors
  • Medium — displays errors and warnings
  • High — displays errors, warnings, and status

Default value is Low level logging when scheduling a command via the MSS in CygNet Explorer.

Default value is High level logging when creating or running an ad-hoc command in FMS Explorer or via the FMS in CygNet Explorer.

Command Parameters

Note: Parameters defining the smart group definitions referenced by the command do not appear in this dialog box, as the definitions and rules are too complex to be shown in this format. Smart group definitions can be viewed and configured via the Extended Options button on the FMS Explorer Commands menu by users with proper security access. See Configuring Smart Group Definitions for more information.

The following command parameters apply to Generate Smart Groups commands, when scheduling, creating, or editing commands via CygNet Explorer or scripting.

Parameter Description Type Required Usage Notes

SmartGroup

Smart group definition name

STRING

Optional

If used, enter the name of the smart group definition to use when executing this command.

Double-click to access the Enter Smart Group Definition Name dialog box, and type a name into the text box. Type in a partial name, in conjunction with wildcard(s), to select multiple definitions matching the description. Wildcard values * (multiple character) and ? (single character) are supported.

This parameter is optional. If not provided, the default value is * (multiple character wildcard); run the command for all smart group definitions.

See Configuring Smart Group Definitions for more information.